Documenting exceptions thrown by a function ( throw )
Documenting exeption is similar to documenting parameters using the \param command. The exception descriptions are also shown in a table after the description section of the function.
Syntax
\throw ExceptionName Description of exception that can be thrown.
|
Output
See
HowToDocument::ExceptionsThrown in the "Exceptions thrown" section.
About section commands
This command is a section command (also called
"Special Sections"). Common to all section commands is the fact that the section continues until a blank line or another section command is encountered.
The section commands are:
\bug, \throw, \internal, \note, \param, \remark, \sa, \todo, \warning \since
(Multiple commands are allowed yielding a bulleted list)
\author \version (Multiple commands are are comma separated in output)
- \brief, \return, \deprecated (Only intended to be used once per entity)